Skip to content

/v1/domains/{domainId}/virtual-ledgers

Request

Create a virtual ledger

Security
httpAuth
Path
domainIdstring, (uuid)required
Body
idstring, (uuid)required
aliasstring, non-emptyrequired
depositIdentificationStrategyobjectrequired
exclusionListArray of objectsrequired
descriptionstringrequired
customPropertiesobjectrequired
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/v1.42/devbox/v1/domains/{domainId}/virtual-ledgers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "alias": "string",
    "depositIdentificationStrategy": {
      "type": "MaximizeSegregation"
    },
    "exclusionList": [
      {
        "exclusionReason": "string",
        "custodyAccountId": "c8caf1e2-9dd3-44b5-afc3-0714a35c0063",
        "custodyDomainId": "a94bdb7e-2101-4127-9e0b-f9db9512329b",
        "type": "CustodyAccount"
      }
    ],
    "description": "string",
    "customProperties": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Virtual Ledger created

Bodyapplication/json
idstring, (uuid)required
aliasstring, non-emptyrequired
depositIdentificationStrategyobjectrequired
exclusionListArray of objectsrequired
metadataobjectrequired
Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "alias": "string", "depositIdentificationStrategy": { "type": "MaximizeSegregation" }, "exclusionList": [ { … } ], "metadata": { "description": "string", "createdAt": "2019-08-24T14:15:22Z", "lastModifiedAt": "2019-08-24T14:15:22Z", "customProperties": { … } } }